core: Fix wrong return value docs
authorKrzesimir Nowak <krzesimir@kinvolk.io>
Wed, 22 Jun 2016 09:16:21 +0000 (11:16 +0200)
committerAtomic Bot <atomic-devel@projectatomic.io>
Wed, 22 Jun 2016 12:45:12 +0000 (12:45 +0000)
ostree_commit_get_parent() returns a string form of a checksum, not a
binary form.

Closes: #360
Approved by: cgwalters

src/libostree/ostree-core.c

index 8e8424fcb5dad36efa0a95a53bd1ef18fe326db9..1a3740f8f711b084f469f0a59213b6f1aa5be2cc 100644 (file)
@@ -1993,8 +1993,9 @@ ostree_validate_structureof_dirmeta (GVariant      *dirmeta,
 /**
  * ostree_commit_get_parent:
  * @commit_variant: Variant of type %OSTREE_OBJECT_TYPE_COMMIT
- * 
- * Returns: Binary checksum with parent of @commit_variant, or %NULL if none
+ *
+ * Returns: Checksum of the parent commit of @commit_variant, or %NULL
+ * if none
  */
 gchar *
 ostree_commit_get_parent (GVariant  *commit_variant)